Class ClusterImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.ClusterImpl
All Implemented Interfaces:
IPCObject, Cluster

public class ClusterImpl extends IPCObjectImpl implements Cluster
Information provided by the PKI file:

    \class Cluster
    
    \brief Clusters used to group clusters inside logical workspace
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • setName

      public void setName(String newName)
      Information provided by the PKI file:
      
          \brief Allows to change cluster name to newName.
          
          \param newName, name to use.
          
              
      Specified by:
      setName in interface Cluster
      Parameters:
      newName - Takes in a parameter of newName
    • getName

      public String getName()
      Information provided by the PKI file:
      
          \brief Returns cluster name.
          
          \return QString, value is the cluster name.
          
              
      Specified by:
      getName in interface Cluster
      Returns:
      String Returns a String
    • getId

      public String getId()
      Information provided by the PKI file:
      
          \brief Returns cluster ID.
          
          \return QString, value is the ID of the cluster.
          
              
      Specified by:
      getId in interface Cluster
      Returns:
      String Returns a String
    • getChildClusterCount

      public int getChildClusterCount()
      Information provided by the PKI file:
      
          \brief Returns the number of child cluster objects
          
          \return int, the number of child clusters inside the cluster.
          
              
      Specified by:
      getChildClusterCount in interface Cluster
      Returns:
      int Returns a int
    • getChildClusterAt

      public Cluster getChildClusterAt(int index)
      Information provided by the PKI file:
      
          \brief Returns child cluster object at a given index
          
          \param index, the index of child cluster to return.
          
          \return Cluster, value is the child cluster at the given index.  Range(0, getContainerCount()-1)
          
              
      Specified by:
      getChildClusterAt in interface Cluster
      Parameters:
      index - Takes in a parameter of index
      Returns:
      Cluster Returns a Cluster
    • getParentCluster

      public Cluster getParentCluster()
      Information provided by the PKI file:
      
          \brief Returns parent cluster object
          
          \return Cluster, value is the parent of the cluster.
          
              
      Specified by:
      getParentCluster in interface Cluster
      Returns:
      Cluster Returns a Cluster
    • getXCoordinate

      public double getXCoordinate()
      Information provided by the PKI file:
      
          \brief Returns the current x-coordinate position in the Logical workspace for this cluster.
          
          \return double, the current x-coordinate.
          
              
      Specified by:
      getXCoordinate in interface Cluster
      Returns:
      double Returns a double
    • getYCoordinate

      public double getYCoordinate()
      Information provided by the PKI file:
      
          \brief Returns the current y-coordinate position in the Logical workspace for this cluster.
          
          \return double, the current y-coordinate.
          
              
      Specified by:
      getYCoordinate in interface Cluster
      Returns:
      double Returns a double
    • getCenterXCoordinate

      public double getCenterXCoordinate()
      Information provided by the PKI file:
      
          \brief Returns the current x-coordinate position in the Logical workspace for this cluster.
          
          \return double, the current x-coordinate.
          
              
      Specified by:
      getCenterXCoordinate in interface Cluster
      Returns:
      double Returns a double
    • getCenterYCoordinate

      public double getCenterYCoordinate()
      Information provided by the PKI file:
      
          \brief Returns the current y-coordinate position in the Logical workspace for this cluster.
          
          \return double, the current y-coordinate.
          
              
      Specified by:
      getCenterYCoordinate in interface Cluster
      Returns:
      double Returns a double
    • moveToLocationCentered

      public boolean moveToLocationCentered(int x, int y)
      Information provided by the PKI file:
      
          \brief Moves this cluster to the specified location for its center in Logical workspace.
          
          \param x, the new x-coordinate position.
          \param y, the new y-coordinate position.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      moveToLocationCentered in interface Cluster
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
      Returns:
      boolean Returns a boolean
    • moveToLocation

      public boolean moveToLocation(int x, int y)
      Information provided by the PKI file:
      
          \brief Moves this cluster to the specified location in Logical workspace.
          
          \param x, the new x-coordinate position.
          \param y, the new y-coordinate position.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      moveToLocation in interface Cluster
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
      Returns:
      boolean Returns a boolean
    • setIconPath

      public void setIconPath(String str)
      Information provided by the PKI file:
      
          \brief Sets the icon to use for the cluster.
          
          \param str, path to the image to use for the cluster icon.
          
              
      Specified by:
      setIconPath in interface Cluster
      Parameters:
      str - Takes in a parameter of str
    • getIconPath

      public String getIconPath()
      Information provided by the PKI file:
      
          \brief Returns the path to the image to use for the cluster icon.
          
          \return QString, the cluster image icon path.
          
              
      Specified by:
      getIconPath in interface Cluster
      Returns:
      String Returns a String